RollupIterator Properties

Scripting > CxVhs > VhsClient Iterator Objects > RollupIterator Object > RollupIterator Properties

RollupIterator Properties

The RollupIterator object contains the following properties. Note the following conditions:

all properties work only with VHS services as the source
all properties apply to the Thin Rollup types (Thin Median, Thin Min/Max, and Thin Last)
all of the properties are write-only.

Property	Type	Read Only	Description
LatestTimeConstrainsRollupEntry	Boolean	No	See description for LatestTimeConstrainsRollupWindow below. The default value is true.
LatestTimeConstrainsRollupWindow	Boolean	N	If this property is set to true, then if the generated rollup window ends on the end time (subject to LatestTimeIsInclusive), no values within that rollup window will be included in the rollup. Example Assume hourly rollups over a 6-hour time window: 00:00 to 01:00 01:00 to 02:00 02:00 to 03:00 03:00 to 04:00 04:00 to 05:00 05:00 to 06:00 And a value at 5:45pm. If this property is set to true, the value will not be included in the rollup. If this property is set to false, the value will be included. If this property is set to true, then the LatestTimeConstrainsRollupEntry property is effectively true, regardless of whether or not it had been set to false. The default value is false.
LatestTimeIsInclusive	Boolean	No	If this property is set to true, and if the value to be included in the thin rollup lands at the exact time specified for the end point, the value will be included in the rollup. Example Assume a bounds of 12:00:00 to 12:01:00. If the property is set to false, and a value is at 12:01:00, the value will not be included in the rollup. If the property is set to true, it would be included in the rollup. The default value is false.

Property

Type

Read Only

Description

LatestTimeConstrainsRollupEntry

Boolean

See description for LatestTimeConstrainsRollupWindow below.

The default value is true.

LatestTimeConstrainsRollupWindow

Boolean

If this property is set to true, then if the generated rollup window ends on the end time (subject to LatestTimeIsInclusive), no values within that rollup window will be included in the rollup.

Example

Assume hourly rollups over a 6-hour time window:

00:00 to 01:00

01:00 to 02:00

02:00 to 03:00

03:00 to 04:00

04:00 to 05:00

05:00 to 06:00

And a value at 5:45pm.

If this property is set to true, the value will not be included in the rollup. If this property is set to false, the value will be included.

If this property is set to true, then the LatestTimeConstrainsRollupEntry property is effectively true, regardless of whether or not it had been set to false.

The default value is false.

LatestTimeIsInclusive

Boolean

If this property is set to true, and if the value to be included in the thin rollup lands at the exact time specified for the end point, the value will be included in the rollup.

Example

Assume a bounds of 12:00:00 to 12:01:00. If the property is set to false, and a value is at 12:01:00, the value will not be included in the rollup. If the property is set to true, it would be included in the rollup.

The default value is false.